Embed API Objects

The following are the main objects in the Embed API library.

  • PyramidEmbedClient - The main api client object. This object manages the life-cycle of the embedded elements on a host page.
  • Embed - this is the central method in the api client used to embed content directly into a host page. The following objects are used in conjunction with this method to tailor the way the embed object works.
    • EmbedOptions- This object represents the embed request selections that are submitted when initializing an embed object
      • QuickEmbedOptions- This object extends EmbedOptions, offering a simplified mechanism to initialize embed objects.
      • ExportTypes - This object represents which export types are available to users in the UI.
    • Filter - This object represents one or more filters that can be attached to embedded content requests
    • Target - This object represents one or more targets that can be attached to embedded 'Present' content requests
    • EmbeddedResult- This object represents the embed result from embedding content
      • Query - this object represents the query objects inside the EmbeddedResult object
      • Hierarchy - this object represents the hierarchy objects inside the Query object
      • Member - this object represents the member objects inside the Hierarchy object

     

  • Hub - this is the central method within the api client used to embed the hub directly into a host page. It returns a Hub object which has is own methods. The following objects are used in conjunction with this method to tailor the way the hub object works.
    • HubEmbedOptions- This object represents the embed request selections that are submitted when initializing an embed object
      • Style - This object represents one or more filters that can be attached to embedded content requests